/**
 * This file is part of Adaptools.
 * 
 * Adaptools is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * Adaptools is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 * along with Adaptools.  If not, see http://www.gnu.org/licenses/. 
 */
package org.adaptools.base;

import org.adaptools.base.exception.AdaptoolsException;

/**
 * Interface to Rule
 * 
 * @author Denys G. Santos (gsdenys@gmail.com)
 * @since 3.0.0
 */
public interface Rule extends Copyable<Rule>{

	/**
	 * @return the id
	 */
	public String getId();

	/**
	 * @param id
	 *            the id to set
	 */
	public void setId(String id);

	/**
	 * @return the header
	 */
	public String getHeader();

	/**
	 * @param header
	 *            the header to set
	 */
	public void setHeader(String header);

	/**
	 * @return the source
	 */
	public String getSource();

	/**
	 * @param source
	 *            the source to set
	 */
	public void setSource(String source);

	/**
	 * @return the input
	 */
	public String getInput();

	/**
	 * @param input
	 *            the input to set
	 */
	public void setInput(String input);

	/**
	 * @return the target
	 */
	public String getTarget();

	/**
	 * @param target
	 *            the target to set
	 */
	public void setTarget(String target);

	/**
	 * @return the push
	 */
	public String getPush();

	/**
	 * @param push
	 *            the push to set
	 */
	public void setPush(String push);

	/**
	 * @return the output
	 */
	public String getOutput();

	/**
	 * @param output
	 *            the output to set
	 */
	public void setOutput(String output);

	/**
	 * @return the adaptive
	 */
	public String getAdaptive();

	/**
	 * @param adaptive
	 *            the adaptive to set
	 */
	public void setAdaptive(String adaptive);

	/**
	 * @return the boolean value to reply if it is an adaptive {@link Rule}
	 */
	public boolean isAdaptiveRule();

	/**
	 * Populate the Rule passing all parameters
	 * 
	 * @param header
	 * @param source
	 * @param input
	 * @param target
	 * @param push
	 * @param output
	 * @param adaptive
	 * @throws AdaptoolsException
	 */
	public void populateRule(String header, String source, String input,
			String target, String push, String output, String adaptive)
			throws AdaptoolsException;

	/**
	 * Populate the Rule passing basics parameters
	 * 
	 * @param header
	 * @param source
	 * @param input
	 * @param target
	 * @throws AdaptoolsException
	 */
	public void populateRule(String header, String source, String input,
			String target) throws AdaptoolsException;
	
	
}